//
// (C) Copyright 2009 Irantha Suwandarathna (irantha@gmail.com)
// All rights reserved.
//

/* Copyright (c) 1995-2000, The Hypersonic SQL Group.
 * All rights reserved.
 *
 * Redistribution and use _in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions _in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer _in the documentation
 * and/or other materials provided with the distribution.
 *
 * Neither the name of the Hypersonic SQL Group nor the names of its
 * contributors may be used to endorse or promote products derived from this
 * software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE HYPERSONIC SQL GROUP,
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * on behalf of the Hypersonic SQL Group.
 *
 *
 * For work added by the HSQL Development Group:
 *
 * Copyright (c) 2001-2008, The HSQL Development Group
 * All rights reserved.
 *
 * Redistribution and use _in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions _in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer _in the documentation
 * and/or other materials provided with the distribution.
 *
 * Neither the name of the HSQL Development Group nor the names of its
 * contributors may be used to endorse or promote products derived from this
 * software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL HSQL DEVELOPMENT GROUP, HSQLDB.ORG,
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */


using System;
using EffiProz.Core.Persist;
using EffiProz.Core.RowIO;
using EffiProz.Core.Lib;
using EffiProz.Core.Indexes;

namespace EffiProz.Core
{

    // fredt@users 20020221 - patch 513005 by sqlbob@users (RMP)
    // fredt@users 20020920 - patch 1.7.1 - refactoring to cut mamory footprint
    // fredt@users 20021215 - doc 1.7.2 - javadoc comments

    /**
     * Base class for a database row object implementing rows for
     * memory resident tables.<p>
     *
     * Subclass CachedRow : rows for CACHED and TEXT tables
     *
     * @author Thomas Mueller (Hypersonic SQL Group)
     * @version 1.8.0
     * @since Hypersonic SQL
     */
    public class RowAVL : Row
    {

        public NodeAVL nPrimaryNode;

        /**
         *  Default constructor used only in subclasses.
         */
        protected RowAVL() { }

        /**
         *  Constructor for MEMORY table Row. .
         */
        public RowAVL(Object[] o)
        {
            rowData = o;
        }

        /**
         *  Constructor for MEMORY table Row. The result is a Row with Nodes that
         *  are not yet linked with other Nodes in the AVL indexes.
         */
        public RowAVL(TableBase t, Object[] o)
        {

            int index = t.getIndexCount();

            nPrimaryNode = new NodeAVLMemory(this);

            NodeAVL n = nPrimaryNode;

            for (int i = 1; i < index; i++)
            {
                n.nNext = new NodeAVLMemory(this);
                n = n.nNext;
            }

            tableId = t.getId();
            rowData = o;
        }

        /**
         * Returns the Node for a given Index, using the ordinal position of the
         * Index within the Table Object.
         */
        virtual public NodeAVL getNode(int index)
        {

            NodeAVL n = nPrimaryNode;

            while (index-- > 0)
            {
                n = n.nNext;
            }

            return n;
        }

        /**
         *  Returns the Node for the next Index on this database row, given the
         *  Node for any Index.
         */
        virtual public NodeAVL getNextNode(NodeAVL n)
        {

            if (n == null)
            {
                n = nPrimaryNode;
            }
            else
            {
                n = n.nNext;
            }

            return n;
        }

        virtual public NodeAVL insertNode(int index)
        {

            NodeAVL backnode = getNode(index - 1);
            NodeAVL newnode = new NodeAVLMemory(this);

            newnode.nNext = backnode.nNext;
            backnode.nNext = newnode;

            return newnode;
        }

        public void clearNonPrimaryNodes()
        {

            NodeAVL n = nPrimaryNode.nNext;

            while (n != null)
            {
                n.delete();

                n.iBalance = 0;
                n = n.nNext;
            }
        }

        public override void restore()
        {

            NodeAVL n = nPrimaryNode;

            while (n != null)
            {
                n.iBalance = 0;
                n = n.nNext;
            }
        }

        public override void destroy()
        {

            //        rowData        = null;
            nPrimaryNode = null;
        }
    }
}
